Skip to main content
Version: 3.7

Advanced

The Advanced tab of the API Configuration page lets you adjust the time for request timeouts, fault message details and response cache for REST, SOAP and GraphQL APIs.

Set the request timeout for a REST API​

  1. Navigate to the REST API's Advanced tab.

The screen appears as shown below.

advancedrest

  1. Ensure that Timeout tab is selected.

  2. Enter the Timeout Value for the Version Level and Resource Level as per the requirement.

  3. Click Save as Draft.

On saving, the confirmation message appears as shown below.

advancedrest1

Set the request timeout for a SOAP API​

  1. Navigate to the SOAP API's Advanced tab.

The screen appears as shown below.

advancedsoap

  1. Ensure that Timeout tab is selected.

  2. Enter the Timeout Value for the Version Level and Operation Level as per the requirement.

  3. Click Save as Draft.

On saving, the confirmation message appears as shown below.

advancedsoap1

Set the request timeout for a GraphQL API​

  1. Navigate to the GraphQL API's Advanced tab.

The screen appears as shown below.

advancedgraphql

  1. Ensure that Timeout tab is selected.

  2. Enter the Timeout Value for the Version Level and Resource Level as per the requirement.

  3. Click Save as Draft.

On saving, the confirmation message appears as shown below.

advancedgraphql

Set REST Fault setup for the REST API​

  1. Navigate to the REST API's Advanced tab.

The screen appears as shown below.

restfault

  1. Select the REST Fault tab.

  2. Click the Expand icon to expand the Default Content Type section.

restfault1

  1. Enable the Overwrite toggle to overwrite at the API Version Level.

  2. Select the JSON, XML, or Plain Text content type that is required to be configured at the API Version Level.

restfault2

  1. Enable the Overwrite toggle to overwrite at the respective Resource Level.

  2. Select the JSON, XML, or Plain Text content type that is required to be configured at the Resource Level.

  3. Click Save as Draft.

On saving, the confirmation message appears as shown below.

restfault3

  1. Click the Expand icon to expand the Default Fault Structure section.

restfault4

  1. Enable the Overwrite toggle to overwrite at the API Version Level.

restfault5

  1. Overwrite the JSON Fault, XML Fault and Plain Text Fault at the API Version Level as per the requirement.

  2. Ensure that the Overwrite toggle is enabled to overwrite at the respective Resource Level.

restfault6

  1. Overwrite the JSON Fault, XML Fault and Plain Text Fault at the respective Resource as per the requirement.

  2. Click Save as Draft.

On saving, the confirmation message appears as shown below.

restfault7

  1. Click the Expand icon to expand the Scenario-wise Fault Message section.

restfault8

  1. Enable the Overwrite toggle to overwrite at the API Version Level.

  2. Overwrite the Response Code, HTTP Code and Fault Message Content at the at the API Version Level if necessary.

  3. Enable the Overwrite toggle to overwrite at the respective Resource Level.

restfault9

  1. Overwrite the Response Code, HTTP Code and Fault Message Content at the at the respective Resource Level if necessary.

  2. Click Save as Draft.

On saving, the confirmation message appears as shown below.

restfault10

Set SOAP Fault setup for the SOAP API​

  1. Navigate to the SOAP API's Advanced tab.

The screen appears as shown below.

soapfault

  1. Select the SOAP Fault tab.

  2. Click the Expand icon to expand the Default Content Type section.

soapfault1

  1. Enable the Overwrite toggle to overwrite at the API Version Level.

  2. Overwrite the XML Fault at the API Version Level if necessary.

  3. Enable the Overwrite toggle to overwrite at the respective Operation Level.

soapfault2

  1. Overwrite the XML Fault at the respective Operation Level if necessary.

  2. Click Save as Draft.

On saving, the confirmation message appears as shown below.

soapfault3

  1. Click the Expand icon to expand the Scenario-wise Fault Message section.

  2. Enable the Overwrite toggle to overwrite at the API Version Level.

soapfault4

  1. Overwrite the Response Code, HTTP Code and Fault Message Content at the at the API Version Level if necessary.

  2. Ensure that the Overwrite toggle is enabled to overwrite at the respective Resource Level.

soapfault5

  1. Overwrite the Response Code, HTTP Code and Fault Message Content at the at the respective Operation Level if necessary.

  2. Click Save as Draft.

On saving, the confirmation message appears as shown below.

soapfault6

Set GraphQL Fault setup for the GraphQL API​

  1. Navigate to the GraphQL API's Advanced tab.

The screen appears as shown below.

graphqlfault

  1. Select the GraphQL Fault tab.

  2. Click the Expand icon to expand the Default Content Type section.

graphqlfault1

  1. Enable the Overwrite toggle to overwrite at the API Version Level.

  2. Overwrite the JSON Fault at the API Version Level if necessary.

  3. Enable the Overwrite toggle to overwrite at the respective Resource Level.

graphqlfault2

  1. Overwrite the JSON Fault at the respective Resource Level.

  2. Click Save as Draft.

On saving, the confirmation message appears as shown below.

graphqlfault3

  1. Click the Expand icon to expand the Scenario-wise Fault Message section.

  2. Enable the Overwrite toggle to overwrite at the API Version Level.

graphqlfault4

  1. Overwrite the Response Code, HTTP Code and Fault Message Content at the at the API Version Level if necessary.

  2. Ensure that the Overwrite toggle is enabled to overwrite at the respective Resource Level.

graphqlfault5

  1. Overwrite the Response Code, HTTP Code and Fault Message Content at the at the respective Resource Level if necessary.

  2. Click Save as Draft.

On saving, the confirmation message appears as shown below.

graphqlfault6

Set Response Cache for the REST API​

info

For REST API, only GET resources will be displayed.

  1. Navigate to the REST API's Advanced tab.

The screen appears as shown below.

restresponsecache

  1. Select the Response Cache tab.

  2. Enable Response Cache toggle to enable response cache at API version level.

  3. Update Cache refreshes in as per the requirement.

  4. Click Evict cache now button to reload the cache at version level.

info

Any changes made to response cache settings at the version level will automatically apply to all resources. You can override the response cache settings at the resource level if necessary.

restresponsecache1

  1. Enable the Override toggle to overwrite at the respective resource level.

  2. Enable/disable the Turn Response Cache to enable/disable the response cache for the respective resource.

  3. Update the Cache refreshes in at the respective resource level as per the requirement.

  4. Click Evict cache now button to reload the cache at the respective resource Level.

  5. Click Save as Draft.

On saving, the confirmation message appears as shown below.

restresponsecache2

info

The response cache is updated whenever data is propagated or a new operation is added to the REST API.

Set Response Cache for the SOAP API​

  1. Navigate to the SOAP API's Advanced tab.

The screen appears as shown below.

soapresponsecache

  1. Select the Response Cache tab.

  2. Enable Response Cache toggle to enable response cache at API version level.

  3. Update Cache refreshes in as per the requirement.

  4. Click Evict cache now button to reload the cache at version level.

info

Any changes made to response cache settings at the version level will automatically apply to all operations. You can override the response cache settings at the operation level if necessary.

soapresponsecache1

  1. Enable the Override toggle to overwrite at the respective resource level.

  2. Enable/disable the Turn Response Cache to enable/disable the response cache for the respective resource.

  3. Update the Cache refreshes in at the respective resource level as per the requirement.

  4. Click Evict cache now button to reload the cache at the respective resource Level.

  5. Click Save as Draft.

On saving, the confirmation message appears as shown below.

soapresponsecache2

info

The response cache is updated whenever data is propagated or a new operation is added to the SOAP API.

Set Response Cache for the GraphQL API​

  1. Navigate to the GraphQL API's Advanced tab.

The screen appears as shown below.

graphqlresponsecache

  1. Select the Response Cache tab.

  2. Enable Response Cache toggle to enable response cache at API version level.

  3. Update Cache refreshes in as per the requirement.

  4. Click Evict cache now button to reload the cache at version level.

info

Any changes made to response cache settings at the version level will automatically apply to all resources. You can override the response cache settings at the resource level if necessary.

graphqlresponsecache1

  1. Enable the Override toggle to overwrite at the respective resource level.

  2. Enable/disable the Turn Response Cache to enable/disable the response cache for the respective resource.

  3. Update the Cache refreshes in at the respective resource level as per the requirement.

  4. Click Evict cache now button to reload the cache at the respective resource Level.

  5. Click Save as Draft.

On saving, the confirmation message appears as shown below.

graphqlresponsecache2

info

The response cache is updated whenever data is propagated or a new operation is added to the Graphql API.